org.eclipse.vtp.framework.interactions.core.commands
Class InputRequestCommand

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand
      org.eclipse.vtp.framework.interactions.core.commands.InputRequestCommand

All Implemented Interfaces:

ICommand

public final class InputRequestCommand
extends ConversationCommand

A command that accepts input from the user.

Author:

Lonnie Pryor

Field Summary

Fields inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

INPUT_TYPE_CUSTOM, INPUT_TYPE_FILE, OUTPUT_TYPE_FILE, OUTPUT_TYPE_TEXT

Constructor Summary

InputRequestCommand()
Creates a new InputRequestCommand.

Method Summary

void	addFileOutput(java.lang.String path) Adds a file output item to this output message.
void	addTextOutput(java.lang.String text) Adds a text output item to this output message.
java.lang.Object	exportContents() Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
java.lang.String	getDataName() Returns the name of the parameter to pass the provided data as.
java.lang.String	getFilledResultValue() Returns the value of the result parameter to pass if the input is valid.
int	getInput2Type() Returns the type of the input descriptor.
java.lang.String	getInput2Value() Returns the value of the input descriptor.
int	getInputType() Returns the type of the input descriptor.
java.lang.String	getInputValue() Returns the value of the input descriptor.
java.lang.String	getNoInputResultValue() Returns the value of the result parameter to pass if the input is missing.
java.lang.String	getNoMatchResultValue() Returns the value of the result parameter to pass if the input is invalid.
int	getOutputCount() Returns the number of output elements configured in this output message.
int	getOutputType(int outputIndex) Returns the type of the output at the specified index.
java.lang.String	getOutputValue(int outputIndex) Returns the value of the output at the specified index.
java.lang.String[]	getParameterNames() Returns the names of the parameters that will be returned from the interaction.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the values of a parameter to be set when the process resumes.
java.lang.String[]	getPropertyNames() Returns the names of the properties of the interaction.
java.lang.String	getPropertyValue(java.lang.String name) Returns the value of a property of the interaction.
java.lang.String	getResultName() Returns the name of the parameter to pass the result of the request as.
void	importContents(java.lang.Object contents) Configures the contents of this command with a structure previously returned from ICommand.exportContents().
void	insertFileOutput(int outputIndex, java.lang.String path) Adds a file output item to this output message at the specified index.
void	insertTextOutput(int outputIndex, java.lang.String text) Adds a text output item to this output message at the specified index.
void	removeOutput(int outputIndex) Removes the output item in this output message at the specified index.
void	setCustomInput(java.lang.String customData) Sets a custom input descriptor.
void	setCustomInput2(java.lang.String customData) Sets a custom input descriptor.
void	setDataName(java.lang.String dataName) Sets the name of the parameter to pass the provided data as.
void	setFileInput(java.lang.String path) Sets the input descriptor to a resource at the specified path.
void	setFileInput2(java.lang.String path) Sets the input descriptor to a resource at the specified path.
void	setFileOutput(int outputIndex, java.lang.String path) Sets the file output item in this output message at the specified index.
void	setFilledResultValue(java.lang.String filledResultValue) Sets the value of the result parameter to pass if the input is valid.
void	setNoInputResultValue(java.lang.String noInputResultValue) Sets the value of the result parameter to pass if the input is missing.
void	setNoMatchResultValue(java.lang.String noMatchResultValue) Sets the value of the result parameter to pass if the input is invalid.
void	setParameterValues(java.lang.String name, java.lang.String[] values) Configures a parameter set when the current process resumes.
void	setPropertyValue(java.lang.String name, java.lang.String value) Configures a property of the interaction.
void	setResultName(java.lang.String resultName) Sets the name of the parameter to pass the result of the request as.
void	setTextOutput(int outputIndex, java.lang.String text) Sets the text output item in this output message at the specified index.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

accept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputRequestCommand

public InputRequestCommand()

Creates a new InputRequestCommand.

Method Detail

getDataName

public java.lang.String getDataName()

Returns the name of the parameter to pass the provided data as.

Returns:

The name of the parameter to pass the provided data as.

setDataName

public void setDataName(java.lang.String dataName)

Sets the name of the parameter to pass the provided data as.

Parameters:

dataName - The name of the parameter to pass the provided data as.

getResultName

public java.lang.String getResultName()

Returns the name of the parameter to pass the result of the request as.

Returns:

The name of the parameter to pass the result of the request as.

setResultName

public void setResultName(java.lang.String resultName)

Sets the name of the parameter to pass the result of the request as.

Parameters:

resultName - The name of the parameter to pass the result of the request as.

getFilledResultValue

public java.lang.String getFilledResultValue()

Returns the value of the result parameter to pass if the input is valid.

Returns:

The value of the result parameter to pass if the input is valid.

setFilledResultValue

public void setFilledResultValue(java.lang.String filledResultValue)

Sets the value of the result parameter to pass if the input is valid.

Parameters:

filledResultValue - The value of the result parameter to pass if the input is valid.

getNoInputResultValue

public java.lang.String getNoInputResultValue()

Returns the value of the result parameter to pass if the input is missing.

Returns:

The value of the result parameter to pass if the input is missing.

setNoInputResultValue

public void setNoInputResultValue(java.lang.String noInputResultValue)

Sets the value of the result parameter to pass if the input is missing.

Parameters:

noInputResultValue - The value of the result parameter to pass if the input is missing.

getNoMatchResultValue

public java.lang.String getNoMatchResultValue()

Returns the value of the result parameter to pass if the input is invalid.

Returns:

The value of the result parameter to pass if the input is invalid.

setNoMatchResultValue

public void setNoMatchResultValue(java.lang.String noMatchResultValue)

Sets the value of the result parameter to pass if the input is invalid.

Parameters:

noMatchResultValue - The value of the result parameter to pass if the input is invalid.

getPropertyNames

public java.lang.String[] getPropertyNames()

Returns the names of the properties of the interaction.

Returns:

The names of the properties of the interaction.

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)

Returns the value of a property of the interaction.

Parameters:

name - The name of the property to be set.

Returns:

The value that the specified property will be set to.

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.String value)

Configures a property of the interaction.

Parameters:

name - The name of the property to set.

value - The value to set the property to.

getOutputCount

public int getOutputCount()

Returns the number of output elements configured in this output message.

Returns:

The number of output elements configured in this output message.

getOutputType

public int getOutputType(int outputIndex)

Returns the type of the output at the specified index.

Parameters:

outputIndex - The index to check.

Returns:

The type of the output at the specified index.

getOutputValue

public java.lang.String getOutputValue(int outputIndex)

Returns the value of the output at the specified index.

Parameters:

outputIndex - The index to check.

Returns:

The value of the output at the specified index.

addFileOutput

public void addFileOutput(java.lang.String path)

Adds a file output item to this output message.

Parameters:

path - The path of the file to render.

addTextOutput

public void addTextOutput(java.lang.String text)

Adds a text output item to this output message.

Parameters:

text - The text to render.

insertFileOutput

public void insertFileOutput(int outputIndex,
                             java.lang.String path)

Adds a file output item to this output message at the specified index.

Parameters:

outputIndex - The index to insert at.

path - The path of the file to render.

insertTextOutput

public void insertTextOutput(int outputIndex,
                             java.lang.String text)

Adds a text output item to this output message at the specified index.

Parameters:

outputIndex - The index to insert at.

text - The text to render.

setFileOutput

public void setFileOutput(int outputIndex,
                          java.lang.String path)

Sets the file output item in this output message at the specified index.

Parameters:

outputIndex - The index to set at.

path - The path of the file to render.

setTextOutput

public void setTextOutput(int outputIndex,
                          java.lang.String text)

Sets the text output item in this output message at the specified index.

Parameters:

outputIndex - The index to set at.

text - The text to render.

removeOutput

public void removeOutput(int outputIndex)

Removes the output item in this output message at the specified index.

Parameters:

outputIndex - The index to remove at.

getInputType

public int getInputType()

Returns the type of the input descriptor.

Returns:

The type of the input descriptor.

getInputValue

public java.lang.String getInputValue()

Returns the value of the input descriptor.

Returns:

The value of the input descriptor.

setFileInput

public void setFileInput(java.lang.String path)

Sets the input descriptor to a resource at the specified path.

Parameters:

path - The path of the resource describing the input to be collected.

setCustomInput

public void setCustomInput(java.lang.String customData)

Sets a custom input descriptor.

Parameters:

customData - The data describing the input constraints.

getInput2Type

public int getInput2Type()

Returns the type of the input descriptor.

Returns:

The type of the input descriptor.

getInput2Value

public java.lang.String getInput2Value()

Returns the value of the input descriptor.

Returns:

The value of the input descriptor.

setFileInput2

public void setFileInput2(java.lang.String path)

Sets the input descriptor to a resource at the specified path.

Parameters:

path - The path of the resource describing the input to be collected.

setCustomInput2

public void setCustomInput2(java.lang.String customData)

Sets a custom input descriptor.

Parameters:

customData - The data describing the input constraints.

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of the parameters that will be returned from the interaction.

Returns:

The names of the parameters that will be returned from the interaction.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns the values of a parameter to be set when the process resumes.

Parameters:

name - The name of the parameter to be set.

Returns:

The values that specified parameter will be set to.

setParameterValues

public void setParameterValues(java.lang.String name,
                               java.lang.String[] values)

Configures a parameter set when the current process resumes.

Parameters:

name - The name of the parameter to set.

values - The values to set the parameter to.

exportContents

public java.lang.Object exportContents()

Description copied from interface: ICommand

Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:

A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)

Description copied from interface: ICommand

Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:

contents - The exported contents structure to load from.